Delete {Gen Ref Line}

Delete

Syntax

SapObject.SapModel.GenRefLine.Delete

VB6 Procedure

Function Delete(ByVal Name As String) As Long

Parameters

Name

The name of an existing general reference line.

Remarks

The function deletes the specified general reference line.

The function returns zero if the general reference line is successfully deleted; otherwise it returns a nonzero value.

VBA Example

Sub DeleteGenRefLine()

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

'create Sap2000 object

Set SapObject = CreateObject("CSI.SAP2000.API.SapObject")

'start Sap2000 application

SapObject.ApplicationStart

'create SapModel object

Set SapModel = SapObject.SapModel

'initialize model

ret = SapModel.InitializeNewModel

'create model from template

ret = SapModel.File.New2DFrame(PortalFrame, 2, 144, 2, 288)

'define new general reference line

ret = SapModel.GenRefLine.SetLine("GRef1", 120, 5)

'delete general reference line

ret = SapModel.GenRefLine.Delete("GRef1")

'close Sap2000

SapObject.ApplicationExit False

Set SapModel = Nothing

Set SapObject = Nothing

End Sub

Release Notes

Initial release in version 15.0.0.

See Also

SetLine

SetLinePlanPoints

SetLineElevPoints